Scripting > CxHmiFms > CxFmsDashboardCtrl Object > CxFmsDashboardCtrl Events

CxFmsDashboardCtrl Events

The CxFmsDashboardCtrl object contains the following events.

EndRefresh

A refresh operation has completed.

Syntax

CxFmsDashboardCtrlObject_EventEndRefresh(Result As Integer, Status As Integer)

Parameters

Parameter Required Description

Result

Yes

An integer specifying whether the refresh succeeded or failed. Possible values for this property are as follows.

  • 0 – Success
  • 1 - Failure

Status

Yes

An integer specifying whether or not the refresh was canceled. Possible values for this property are as follows.

  • 0 – Not canceled
  • 1 - Canceled

Example

The following example displays a message box if the refresh was canceled.

  

Sub FmsDashboard_EventEndRefresh(Result, Status)

Dim This : Set This = FmsDashboard

If Status = 1 Then

MsgBox "Refresh canceled"

End If

End Sub

Back to top

Initialize

The control is initialized.

Syntax

CxFmsDashboardCtrlObject_EventInitialize()

Example

The following example displays a message box when the control is initialized.

  

Sub FmsDashboard_EventInitialize()

Dim This : Set This = FmsDashboard

MsgBox "Control initialized"

End Sub

Back to top

PumpData

(Obsolete)

Back to top

SetSessionNode

The Session Node has been set via the "Set as Session Node" context menu item (or via the Ctrl+Shift+S keyboard shortcut).

Syntax

CxFmsDashboardCtrlObject_EventSetSessionNode(NodeId As Integer)

Parameters

Parameter Required Description

NodeId

Yes

The ID of the Node that was set as the Session Node.

Example

The following example displays a message box when the Session Node is set.

  

Sub FmsDashboard_EventSetSessionNode(NodeId)

Dim This : Set This = FmsDashboard

MsgBox CStr(NodeId)

End Sub

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.